-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
OptionsMonitor`1.xml
208 lines (208 loc) · 15 KB
/
OptionsMonitor`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<Type Name="OptionsMonitor<TOptions>" FullName="Microsoft.Extensions.Options.OptionsMonitor<TOptions>">
<TypeSignature Language="C#" Value="public class OptionsMonitor<TOptions> : IDisposable, Microsoft.Extensions.Options.IOptionsMonitor<TOptions> where TOptions : class" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OptionsMonitor`1<class TOptions> extends System.Object implements class Microsoft.Extensions.Options.IOptionsMonitor`1<!TOptions>, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Options.OptionsMonitor`1" />
<TypeSignature Language="VB.NET" Value="Public Class OptionsMonitor(Of TOptions)
Implements IDisposable, IOptionsMonitor(Of TOptions)" />
<TypeSignature Language="F#" Value="type OptionsMonitor<'Options (requires 'Options : null)> = class
 interface IOptionsMonitor<'Options (requires 'Options : null)>
 interface IDisposable" />
<TypeSignature Language="C++ CLI" Value="generic <typename TOptions>
 where TOptions : classpublic ref class OptionsMonitor : IDisposable, Microsoft::Extensions::Options::IOptionsMonitor<TOptions>" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Options</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TOptions">
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)>]</AttributeName>
</Attribute>
</Attributes>
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Extensions.Options.IOptionsMonitor<TOptions></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="TOptions">Options type.</typeparam>
<summary>Implementation of <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OptionsMonitor (Microsoft.Extensions.Options.IOptionsFactory<TOptions> factory, System.Collections.Generic.IEnumerable<Microsoft.Extensions.Options.IOptionsChangeTokenSource<TOptions>> sources, Microsoft.Extensions.Options.IOptionsMonitorCache<TOptions> cache);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.Options.IOptionsFactory`1<!TOptions> factory, class System.Collections.Generic.IEnumerable`1<class Microsoft.Extensions.Options.IOptionsChangeTokenSource`1<!TOptions>> sources, class Microsoft.Extensions.Options.IOptionsMonitorCache`1<!TOptions> cache) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Options.OptionsMonitor`1.#ctor(Microsoft.Extensions.Options.IOptionsFactory{`0},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IOptionsChangeTokenSource{`0}},Microsoft.Extensions.Options.IOptionsMonitorCache{`0})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (factory As IOptionsFactory(Of TOptions), sources As IEnumerable(Of IOptionsChangeTokenSource(Of TOptions)), cache As IOptionsMonitorCache(Of TOptions))" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.Options.OptionsMonitor<'Options (requires 'Options : null)> : Microsoft.Extensions.Options.IOptionsFactory<'Options (requires 'Options : null)> * seq<Microsoft.Extensions.Options.IOptionsChangeTokenSource<'Options>> * Microsoft.Extensions.Options.IOptionsMonitorCache<'Options (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsMonitor<'Options (requires 'Options : null)>" Usage="new Microsoft.Extensions.Options.OptionsMonitor<'Options (requires 'Options : null)> (factory, sources, cache)" />
<MemberSignature Language="C++ CLI" Value="public:
 OptionsMonitor(Microsoft::Extensions::Options::IOptionsFactory<TOptions> ^ factory, System::Collections::Generic::IEnumerable<Microsoft::Extensions::Options::IOptionsChangeTokenSource<TOptions> ^> ^ sources, Microsoft::Extensions::Options::IOptionsMonitorCache<TOptions> ^ cache);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Options</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="factory" Type="Microsoft.Extensions.Options.IOptionsFactory<TOptions>" />
<Parameter Name="sources" Type="System.Collections.Generic.IEnumerable<Microsoft.Extensions.Options.IOptionsChangeTokenSource<TOptions>>" />
<Parameter Name="cache" Type="Microsoft.Extensions.Options.IOptionsMonitorCache<TOptions>" />
</Parameters>
<Docs>
<param name="factory">The factory to use to create options.</param>
<param name="sources">The sources used to listen for changes to the options instance.</param>
<param name="cache">The cache used to store options.</param>
<summary>Constructor.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentValue">
<MemberSignature Language="C#" Value="public TOptions CurrentValue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance !TOptions CurrentValue" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Options.OptionsMonitor`1.CurrentValue" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CurrentValue As TOptions" />
<MemberSignature Language="F#" Value="member this.CurrentValue : 'Options" Usage="Microsoft.Extensions.Options.OptionsMonitor<'Options (requires 'Options : null)>.CurrentValue" />
<MemberSignature Language="C++ CLI" Value="public:
 property TOptions CurrentValue { TOptions get(); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Extensions.Options.IOptionsMonitor`1.CurrentValue</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Options</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>The present value of the options.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> when validating the <typeparamref name="TOptions" /> instance been created.</exception>
<exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions" /> does not have a public parameterless constructor or <typeparamref name="TOptions" /> is <see langword="abstract" />.</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Options.OptionsMonitor`1.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="optionsMonitor.Dispose " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void Dispose();" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Options</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Removes all change registration subscriptions.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual TOptions Get (string? name);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TOptions Get(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Options.OptionsMonitor`1.Get(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Get (name As String) As TOptions" />
<MemberSignature Language="F#" Value="abstract member Get : string -> 'Options
override this.Get : string -> 'Options" Usage="optionsMonitor.Get name" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual TOptions Get(System::String ^ name);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Extensions.Options.IOptionsMonitor`1.Get(System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Options</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TOptions</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="name">The name of the <typeparamref name="TOptions" /> instance. If <see langword="null" />, <see cref="F:Microsoft.Extensions.Options.Options.DefaultName" />, which is the empty string, is used.</param>
<summary>Returns a configured <typeparamref name="TOptions" /> instance with the given <paramref name="name" />.</summary>
<returns>The <typeparamref name="TOptions" /> instance that matches the given <paramref name="name" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> when validating the <typeparamref name="TOptions" /> instance been created.</exception>
<exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions" /> does not have a public parameterless constructor or <typeparamref name="TOptions" /> is <see langword="abstract" />.</exception>
</Docs>
</Member>
<Member MemberName="OnChange">
<MemberSignature Language="C#" Value="public IDisposable OnChange (Action<TOptions,string> listener);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.IDisposable OnChange(class System.Action`2<!TOptions, string> listener) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Options.OptionsMonitor`1.OnChange(System.Action{`0,System.String})" />
<MemberSignature Language="VB.NET" Value="Public Function OnChange (listener As Action(Of TOptions, String)) As IDisposable" />
<MemberSignature Language="F#" Value="abstract member OnChange : Action<'Options, string (requires 'Options : null)> -> IDisposable
override this.OnChange : Action<'Options, string (requires 'Options : null)> -> IDisposable" Usage="optionsMonitor.OnChange listener" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual IDisposable ^ OnChange(Action<TOptions, System::String ^> ^ listener);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Extensions.Options.IOptionsMonitor`1.OnChange(System.Action{`0,System.String})</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Options</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IDisposable</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="listener" Type="System.Action<TOptions,System.String>" />
</Parameters>
<Docs>
<param name="listener">The action to be invoked when <typeparamref name="TOptions" /> has changed.</param>
<summary>Registers a listener to be called whenever <typeparamref name="TOptions" /> changes.</summary>
<returns>An <see cref="T:System.IDisposable" /> which should be disposed to stop listening for changes.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>